ALMaSS: Skylark_Base Class Reference

#include <skylarks_all.h>

Inheritance diagram for Skylark_Base:

Public Member Functions
	Skylark_Base (int x, int y, SkTerritories Terrs, Landscape L, Skylark_Population_Manager *SPM, int bx, int by, int mh)

virtual void	ReInit (int x, int y, SkTerritories Terrs, Landscape L, Skylark_Population_Manager *SPM, int bx, int by, int mh)

virtual double	On_FoodSupply (double)

void	AddStriglingMort (int lifestage)

virtual int	WhatState ()

bool	InSquare (rectangle R)

Public Member Functions inherited from TAnimal
unsigned	SupplyFarmOwnerRef ()

AnimalPosition	SupplyPosition ()

APoint	SupplyPoint ()

int	SupplyPolygonRef ()

int	Supply_m_Location_x ()

int	Supply_m_Location_y ()

virtual void	KillThis ()

virtual void	CopyMyself ()

void	SetX (int a_x)

void	SetY (int a_y)

	TAnimal (int x, int y, Landscape *L)

virtual void	BeginStep (void)
	BeingStep behaviour - must be implemented in descendent classes. More...

virtual void	Step (void)
	Step behaviour - must be implemented in descendent classes. More...

virtual void	EndStep (void)
	EndStep behaviour - must be implemented in descendent classes. More...

virtual void	ReinitialiseObject (int x, int y, Landscape *L)
	Used to re-use an object - must be implemented in descendent classes. More...

virtual void	Dying ()

void	CheckManagement (void)

void	CheckManagementXY (int x, int y)

virtual bool	OnFarmEvent (FarmToDo)

Public Member Functions inherited from TALMaSSObject
int	GetCurrentStateNo ()
	Returns the current state number. More...

void	SetCurrentStateNo (int a_num)
	Sets the current state number. More...

bool	GetStepDone ()
	Returns the step done indicator flag. More...

void	SetStepDone (bool a_bool)
	Sets the step done indicator flag. More...

virtual void	ReinitialiseObject ()
	Used to re-use an object - must be implemented in descendent classes. More...

	TALMaSSObject ()
	The constructor for TALMaSSObject. More...

virtual	~TALMaSSObject ()
	The destructor for TALMaSSObject. More...

void	OnArrayBoundsError ()
	Used for debugging only, tests basic object properties. More...

Public Attributes
double	m_pesticide_accumulation

double	m_pcide_conc

TTypesOfSkState	m_CurrentSkState

int	Age

double	m_Size

int	m_Born_x

int	m_Born_y

int	m_MyHome
	The vegetation type where the skylark was born. More...

SkTerritories *	m_OurTerritories

Skylark_Population_Manager *	m_OurPopulationManager

Protected Member Functions
bool	DailyMortality (int mort)

virtual void	PesticideResponse ()

Protected Member Functions inherited from TAnimal
void	CorrectWrapRound ()
	Corrects wrap around co-ordinate problems. More...

Additional Inherited Members
Protected Attributes inherited from TAnimal
int	m_Location_x

int	m_Location_y

Landscape *	m_OurLandscape

Protected Attributes inherited from TALMaSSObject
int	m_CurrentStateNo
	The basic state number for all objects - '-1' indicates death. More...

bool	m_StepDone
	Indicates whether the iterative step code is done for this timestep. More...

Constructor & Destructor Documentation

◆ Skylark_Base()

Skylark_Base::Skylark_Base	(	int	x,
		int	y,
		SkTerritories *	Terrs,
		Landscape *	L,
		Skylark_Population_Manager *	SPM,
		int	bx,
		int	by,
		int	mh
	)

                       : TAnimal( x, y, L ) {
        m_OurTerritories = Terrs;
        m_OurPopulationManager = SPM;
        // Make sure that the skylark starts in the correct state
        m_CurrentSkState = toss_Initiation;
        m_CurrentStateNo = 0;
        m_Born_x = bx;
        m_Born_y = by;
        m_MyHome = mh;
        m_pesticide_accumulation = 0;
 }

References m_Born_x, m_Born_y, m_CurrentSkState, TALMaSSObject::m_CurrentStateNo, m_MyHome, m_OurPopulationManager, m_OurTerritories, m_pesticide_accumulation, and toss_Initiation.

Member Function Documentation

◆ AddStriglingMort()

void Skylark_Base::AddStriglingMort ( int lifestage )

inline

   {
     m_OurPopulationManager->AddStriglingMort( lifestage );
  
   }

References Skylark_Population_Manager::AddStriglingMort().

Referenced by Skylark_Clutch::OnFarmEvent(), Skylark_Nestling::OnFarmEvent(), Skylark_PreFledgeling::OnFarmEvent(), and Skylark_Female::OnFarmEvent().

◆ DailyMortality()

bool Skylark_Base::DailyMortality ( int mort )

protected

                                             {
 #ifdef __CJTDebug_5
   if ( IsAlive() != 0x0DEADC0DE ) DEADCODEError();
 #endif
   // Timing: Must be called once each day and if true then death
   //returns true if the object must die
   int ch = random( 10000 );
   if ( ch < mort ) return true; else
     return false;
 }

References random().

Referenced by Skylark_Clutch::st_Developing(), Skylark_Nestling::st_Developing(), and Skylark_PreFledgeling::st_Developing().

◆ InSquare()

bool Skylark_Base::InSquare ( rectangle R )

                                            {
 #ifdef __CJTDebug_5
   if ( IsAlive() != 0x0DEADC0DE ) DEADCODEError();
 #endif
   if ( ( m_Location_x >= int( p_R.m_x1 ) ) && ( m_Location_x < int( p_R.m_x2 ) ) && ( m_Location_y >= int( p_R.m_y1 ) )
        && ( m_Location_y < int( p_R.m_y2 ) ) )
          return true; else
     return false;
 }

References TAnimal::m_Location_x, TAnimal::m_Location_y, rectangle::m_x1, rectangle::m_x2, rectangle::m_y1, and rectangle::m_y2.

◆ On_FoodSupply()

virtual double Skylark_Base::On_FoodSupply ( double )

inlinevirtual

Reimplemented in Skylark_Nestling.

   {
     return 0.0;
   }

◆ PesticideResponse()

virtual void Skylark_Base::PesticideResponse ( void )

inlineprotectedvirtual

Reimplemented in Skylark_Nestling, Skylark_Male, Skylark_Female, and Skylark_PreFledgeling.

629 { return; }

◆ ReInit()

void Skylark_Base::ReInit	(	int	x,
		int	y,
		SkTerritories *	Terrs,
		Landscape *	L,
		Skylark_Population_Manager *	SPM,
		int	bx,
		int	by,
		int	mh
	)

virtual

                                                                                                                                       {
     TAnimal::ReinitialiseObject(x, y, L);
     // Assign the pointer to the population manager
     m_OurTerritories = Terrs;
     m_OurPopulationManager = SPM;
     // Make sure that the skylark starts in the correct state
     m_CurrentSkState = toss_Initiation;
     m_CurrentStateNo = 0;
     m_Born_x = bx;
     m_Born_y = by;
     m_MyHome = mh;
     m_pesticide_accumulation = 0;
 }

References m_Born_x, m_Born_y, m_CurrentSkState, TALMaSSObject::m_CurrentStateNo, m_MyHome, m_OurPopulationManager, m_OurTerritories, m_pesticide_accumulation, TALMaSSObject::ReinitialiseObject(), and toss_Initiation.

Referenced by Skylark_Adult::ReInit(), Skylark_Nestling::ReInit(), and Skylark_Clutch::ReInit().

◆ WhatState()

virtual int Skylark_Base::WhatState ( )

inlinevirtual

Reimplemented from TAnimal.

   {
     return m_CurrentSkState;
   }

Referenced by Skylark_Population_Manager::ProbePOM().

Member Data Documentation

◆ Age

int Skylark_Base::Age

Referenced by Skylark_Male::DefendTerritory(), Skylark_PreFledgeling::GetFood(), Skylark_Female::GetMigrationMortality(), Skylark_Male::GetMigrationMortality(), Skylark_Nestling::On_FoodSupply(), Skylark_PreFledgeling::OnFarmEvent(), Skylark_Adult::ReInit(), Skylark_PreFledgeling::ReInit(), Skylark_Nestling::ReInit(), Skylark_Clutch::ReInit(), Skylark_Adult::Skylark_Adult(), Skylark_Clutch::Skylark_Clutch(), Skylark_Nestling::Skylark_Nestling(), Skylark_PreFledgeling::Skylark_PreFledgeling(), Skylark_Male::st_CaringForYoung(), Skylark_Clutch::st_Developing(), Skylark_Nestling::st_Developing(), Skylark_PreFledgeling::st_Developing(), Skylark_Female::st_Emigrating(), Skylark_Male::st_Emigrating(), Skylark_Male::st_FindingTerritory(), Skylark_Female::st_Immigrating(), Skylark_Male::st_Immigrating(), Skylark_Nestling::st_Maturing(), Skylark_Male::Step(), Skylark_Male::SupplyBroodAge(), and Skylark_Population_Manager::TheFledgelingProbe().

◆ m_Born_x

int Skylark_Base::m_Born_x

Referenced by Skylark_Adult::CopyMyself(), ReInit(), Skylark_Base(), Skylark_Male::st_Arriving(), Skylark_Clutch::st_Hatching(), Skylark_Nestling::st_Maturing(), and Skylark_PreFledgeling::st_Maturing().

◆ m_Born_y

int Skylark_Base::m_Born_y

◆ m_CurrentSkState

TTypesOfSkState Skylark_Base::m_CurrentSkState

Referenced by Skylark_Female::BeginStep(), Skylark_Male::BeginStep(), Skylark_Population_Manager::BreedingPairsOutput(), Skylark_Clutch::EndStep(), Skylark_Nestling::EndStep(), Skylark_PreFledgeling::EndStep(), Skylark_Male::EndStep(), Skylark_Female::OnBroodDeath(), Skylark_Male::OnBroodDeath(), Skylark_Female::OnClutchDeath(), Skylark_Nestling::OnDeserted(), Skylark_Male::OnEggHatch(), Skylark_Female::OnEggsHatch(), Skylark_Male::OnEvicted(), Skylark_Clutch::OnFarmEvent(), Skylark_Nestling::OnFarmEvent(), Skylark_PreFledgeling::OnFarmEvent(), Skylark_Female::OnFarmEvent(), Skylark_Male::OnFarmEvent(), Skylark_Female::OnMateDying(), Skylark_Male::OnMateDying(), Skylark_Female::OnMateHomeless(), Skylark_Male::OnMateLeaving(), Skylark_Clutch::OnMumGone(), Skylark_Male::OnPairing(), Skylark_Male::OnPreFledgelingMature(), Skylark_Male::OnReHouse(), Skylark_Female::OnStopFeedingChicks(), Skylark_Nestling::OnYouHaveBeenEaten(), Skylark_PreFledgeling::PesticideResponse(), Skylark_Nestling::PesticideResponse(), Skylark_PreFledgeling::ReInit(), ReInit(), Skylark_Female::SensibleCopy(), Skylark_Male::SensibleCopy(), Skylark_Base(), Skylark_PreFledgeling::Skylark_PreFledgeling(), Skylark_Clutch::st_Dying(), Skylark_Nestling::st_Dying(), Skylark_PreFledgeling::st_Dying(), Skylark_Female::st_Dying(), Skylark_Male::st_Dying(), Skylark_Male::st_FollowingMate(), Skylark_Clutch::Step(), Skylark_Nestling::Step(), Skylark_PreFledgeling::Step(), Skylark_Female::Step(), and Skylark_Male::Step().

◆ m_MyHome

int Skylark_Base::m_MyHome

The vegetation type where the skylark was born.

Referenced by Skylark_Adult::CopyMyself(), ReInit(), Skylark_Base(), Skylark_Clutch::st_Hatching(), Skylark_Nestling::st_Maturing(), Skylark_PreFledgeling::st_Maturing(), and Skylark_Population_Manager::TheFledgelingProbe().

◆ m_OurPopulationManager

Skylark_Population_Manager* Skylark_Base::m_OurPopulationManager

◆ m_OurTerritories

SkTerritories* Skylark_Base::m_OurTerritories

◆ m_pcide_conc

double Skylark_Base::m_pcide_conc

Referenced by Skylark_Female::FeedYoung(), Skylark_Adult::RemoveEM(), and Skylark_Male::st_CaringForYoung().

◆ m_pesticide_accumulation

double Skylark_Base::m_pesticide_accumulation

Referenced by Skylark_PreFledgeling::PesticideResponse(), Skylark_Female::PesticideResponse(), Skylark_Male::PesticideResponse(), Skylark_Nestling::PesticideResponse(), ReInit(), Skylark_Adult::RemoveEM(), Skylark_Base(), and Skylark_Male::st_CaringForYoung().

◆ m_Size

double Skylark_Base::m_Size

Referenced by Skylark_Adult::CopyMyself(), Skylark_Nestling::On_FoodSupply(), Skylark_Female::PesticideResponse(), Skylark_Nestling::PesticideResponse(), Skylark_Adult::ReInit(), Skylark_PreFledgeling::ReInit(), Skylark_Nestling::ReInit(), Skylark_Adult::Skylark_Adult(), Skylark_Nestling::Skylark_Nestling(), Skylark_PreFledgeling::Skylark_PreFledgeling(), Skylark_Male::st_CaringForYoung(), Skylark_Nestling::st_Developing(), Skylark_PreFledgeling::st_Developing(), Skylark_Nestling::st_Maturing(), Skylark_PreFledgeling::st_Maturing(), and Skylark_Male::SupplyBroodWeight().

The documentation for this class was generated from the following files:

/builds/a1mass/almass_stable_oddox/Skylark/skylarks_all.h
/builds/a1mass/almass_stable_oddox/Skylark/skylarks_all.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members